home *** CD-ROM | disk | FTP | other *** search
/ TeX 1995 July / TeX CD-ROM July 1995 (Disc 1)(Walnut Creek)(1995).ISO / graphics / texdraw / README < prev    next >
Text File  |  1992-07-06  |  8KB  |  178 lines
  1. This file describes the contents of the distribution for TeXdraw
  2.  
  3. $Id: README,v 1.9 1992/07/07 14:37:58 kabal Rel $
  4.  
  5. The TeXdraw package consists of a set of macro definitions for the TeX
  6. typesetting program.  These macros allow the user to produce PostScript
  7. drawings from within TeX.
  8.  
  9. The main benefits of TeXdraw accrue from the ability to produce drawings
  10. from <within> TeX, using TeX fonts for labelling the drawing.
  11.  
  12. TeXdraw interfaces with the dvips (dvi to PostScript) print program.
  13.  
  14. Basic drawing features include:
  15. (1) moves, lines and arrow vectors
  16.     - selectable gray level, line width pattern, arrowhead size and type
  17. (2) circles, ellipses, arcs, and Bezier curves
  18. (3) general fill command to fill a region defined by lines and Bezier
  19.     curves (selectable gray level)
  20. (4) TeX text, including mathematics, can be positioned and superimposed
  21.     on the drawing
  22.  
  23. TeXdraw has been designed to be extensible.  Drawing "segments" are
  24. relocatable, self-contained units.  Using a combination of the begingroup/
  25. endgroup mechanism in TeX and the gsave/grestore mechanism in PostScript,
  26. drawing segments allow for local changes to the scaling and line parameters.
  27. Using TeX's macro definition capability, new drawing commands can be
  28. constructed from drawing segments.
  29.  
  30. The extensibility features include,
  31. (1) relocatable drawing segments to keep changes local
  32. (2) local segment scaling
  33. (3) saving and restoring positions using symbolic positions
  34.  
  35. =====
  36. Peter Kabal                            kabal@aldebaran.EE.McGill.CA
  37. Department of Electrical Engineering
  38. McGill University
  39. Montreal, Quebec
  40.  
  41.  
  42. =====
  43. The distribution consists of the TeXdraw macros themselves, files with
  44. auxiliary macros, and the TeXdraw manual (texinfo format, also as a
  45. PostScript file).
  46.  
  47. Distribution Contents:
  48. ----------------------
  49.  
  50. Miscellaneous:
  51.   README              - this file
  52.  
  53. TeXdraw macros (main directory):
  54.   texdraw.tex         - TeXdraw macros for TeX
  55.   texdraw.sty         - LaTeX interface to TeXdraw
  56.   txdtools.tex        - TeXdraw toolbox for extending TeXdraw
  57.   txdps.tex           - TeXdraw macros for accessing PostScript macros
  58.   blockdiagram.tex    - Block diagram macros for TeXdraw
  59.   txdexamp.tex        - plain TeX code for the examples in the manual
  60.   txdexamp.latex      - LaTeX code for the examples in the manual
  61.  
  62. compacted TeXdraw macros (directory compact/):
  63.   texdraw.tex
  64.   txdtools.tex
  65.   txdps.tex
  66.  
  67. TeXdraw documentation (directory manual/):
  68.   texdraw.ps          - PostScript version of the manual
  69.   texdraw.texi        - Texinfo source file for the TeXdraw manual
  70.   texdraw.aux         - cross-references (generated by an earlier run, used
  71.                         as input when TeX'ing the manual)
  72.   texdraw.cps         - concept index (generated by an earlier run, used as
  73.                         input when TeX'ing the manual)
  74.   texdraw.fns         - sorted functon index (generated by an earlier run,
  75.                         used as input when TeX'ing the manual).
  76.  
  77. GNU Texinfo utilities (directory manual/):
  78.   texindex.c          - Source for the texindex program (Version 1.45)
  79.   getopt.h            - Include file for texindex.c
  80.   texinfo.tex         - Texinfo macros used to make manuals and on-line
  81.                         documentation (Version 2.72)
  82.   texi2dvi            - Script to run TeX and texindex (Version 0.2)
  83.  
  84. ===============================================
  85. The following notes on setup are Unix oriented.
  86.  
  87. Initial Setup:
  88.  
  89. (1) Print the PostScript version of the manual ("texdraw.ps") to see the
  90.     capabilities of TeXdraw.  This is a large file which will waste large
  91.     amounts of paper if printed on a non-PostScript printer.  You must have
  92.     a PostScript printer.  Typically, the file can be printed with
  93.     % lpr texdraw.ps
  94. (2) Try TeX'ing the examples file.  Assuming plain TeX is invoked with the
  95.     command "tex",
  96.     % tex txdexamp
  97. (3) Make sure you have dvips by Tom Rokicki as your dvi to PostScript converter
  98.     program.  The \special syntax generated by the TeXdraw macros may not
  99.     be compatible with other converter programs. Try printing the examples
  100.     % dvips txdexamp
  101.  
  102. =====
  103. Permanent Setup:
  104.  
  105. Compact source files:
  106. In the subdirectory "compact", there are versions of the macro files
  107. with most comments and white space removed.
  108.  
  109. (1) Private copy of TeXdraw.
  110.     Move the TeXdraw sources files ("texdraw.tex", "txdtools.tex" and
  111.     "txdps.tex") to an appropriate directory.  If you are keeping private
  112.     versions of the files, consider the directory ~mylogin/tex . With many
  113.     versions of TeX, setting your default path variable (the environment
  114.     variable TEXINPUTS) to include this directory allows you to refer to
  115.     the files in TeX without specifying the full pathname.  With the C-shell,
  116.     a line in the ".login" file sets the environment variable TEXINPUTS
  117.  
  118.     setenv TEXINPUTS ".:$HOME/tex:".
  119.     
  120.     The last part of the path string should terminate with a colon to have
  121.     the default directory of public TeX files available.
  122. (2) Public copy of TeXdraw.
  123.     Move the TeXdraw source files ("texdraw.tex", "txdtools.tex" and
  124.     "txdps.tex") to a directory that TeX searches by default.  This
  125.     might be a directory such as "/usr/local/lib/tex/inputs". Newer
  126.     versions of TeX allow subdirectory searching - this keeps things
  127.     organized.  In that case, use "/usr/local/lib/tex/inputs/TeXdraw".
  128.  
  129. =====
  130. The following instructions pertain to installing the ability to use the
  131. Texinfo system for any texinfo type manual.
  132. (1) The GNU program "texindex" should built using
  133.     % cc texindex.c -o texindex
  134.     Move the program to an appropriate place such as "/usr/local/bin".
  135. (2) The GNU script "texi2dvi" runs TeX and texindex for a texinfo file. Move 
  136.     this script to an appropriate place such as "/usr/local/bin".
  137. (3) The GNU "texinfo.tex" file should go into the public directories searched
  138.     by TeX, for instance "/usr/local/lib/tex/inputs", (or
  139.     "/usr/local/lib/tex/inputs/texinfo" if you have a version of TeX which
  140.     searches subdirectories).
  141.  
  142. =====
  143. Creating a TeXdraw manual from the sources:
  144. (1) Make sure "texdraw.tex", "txdtools.tex" and "texinfo.tex" will be found
  145.     by TeX.
  146. (2) To create the manual, you have to TeX the manual twice - the second
  147.     time to access the sorted indices and the cross-references.  The program
  148.     "texindex" sorts the indices.  (The distribution includes pre-sorted
  149.     indices that can be used).  The three steps can be replaced by an
  150.     invokation of the script "texi2dvi".
  151.     % tex texdraw.texinfo
  152.     % texindex texdraw
  153.     % tex texdraw.texinfo
  154. (3) Try printing some part of the newly created manual.  The Texinfo macros
  155.     use standard fonts at not-so standard magnifications.  As a result dvips
  156.     may have to run Metafont to create the new font bit-maps.  To print
  157.     part of the manual, say pages 29 and 30, use
  158.     % dvips -p 29 -l 30 texdraw
  159. (4) If you use the GNU emacs editor, the file texdraw.texi can find a
  160.     permanent home in the directory, "/usr/local/emacs/man" or its equivalent
  161.     on your system.
  162.  
  163. =====
  164. On-line info manual:
  165.  
  166. Consider building an info version of the manual.  For this you need the
  167. GNU program "makeinfo" (available by anonymous ftp from prep.ai.mit.edu
  168. as part of texinfo-2.15.tar.Z).  After running "makeinfo texdraw", the top
  169. level info directory file "dir" in /usr/local/emacs/info needs to be updated
  170. to include a menu entry for TeXdraw.  This entry is of the form
  171. * TeXdraw: (texdraw).
  172.         TeXdraw is a collection of macros that allow drawings to be
  173.                 created from within TeX.
  174. Also the files produced by makeinfo (texdraw, texdraw-1 and texdraw-2) need
  175. to be moved there.  The info file can be read from within the emacs editor,
  176. or with the info reader program "info" (also part of the texinfo-2.15
  177. distribution).
  178.